Conversation
added 2 commits
April 21, 2026 13:24
sed-i
commented
Apr 21, 2026
| ## Create Terraform plan | ||
|
|
||
| ```hcl | ||
| module ... { ... } |
Contributor
Author
There was a problem hiding this comment.
@MichaelThamm are we ready to put something here now?
Contributor
There was a problem hiding this comment.
Partially blocked by:
| If you don't yet know how much telemetry your workloads generate, start with [How to evaluate telemetry volume](/how-to/configure-and-tune/evaluate-telemetry-volume). | ||
|
|
||
| Follow the [storage best practices](/reference/storage) to set up a distributed storage backend with a replication factor of 3. | ||
| Do **not** use `hostPath` storage in production. |
Contributor
There was a problem hiding this comment.
Perhaps a brief explanation about "why not to use hostPath"?
Comment on lines
+68
to
+69
| Only the Grafana and Traefik charms support auth. | ||
| For exposing Grafana publicly, use two Traefik charms, one for internal connections, and another for external access, which will provide ingress to Grafana. |
Contributor
There was a problem hiding this comment.
One minor suggestion:
Suggested change
| Only the Grafana and Traefik charms support auth. | |
| For exposing Grafana publicly, use two Traefik charms, one for internal connections, and another for external access, which will provide ingress to Grafana. | |
| Only the Grafana and Traefik charms support authentication. | |
| To expose Grafana publicly, deploy two Traefik charms: one for internal connections and another for external access to provide ingress. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new installation guide under the “Deploy and manage” docs, and updates related navigation/style guidance in the documentation set.
Changes:
- Add
How to install COSguide with preparation checklist and initial deployment sections. - Update the deploy-and-manage index to include the new install page and reorganize the Upgrades section.
- Expand telemetry-volume guidance with manual evaluation steps for metrics/logs; update docs review prompt to specify US English spelling.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
docs/how-to/deploy-and-manage/install.md |
New installation guide content for COS/COS Lite (prep + initial deployment outline). |
docs/how-to/deploy-and-manage/index.md |
Adds the install page to the Deploy toctree and moves Upgrades into its own section. |
docs/how-to/configure-and-tune/evaluate-telemetry-volume.md |
Adds manual evaluation subsections for metrics/logs, but introduces/contains formatting issues that can break rendering. |
.github/prompts/review-docs.prompt.md |
Updates docs review checklist to specify US English spelling. |
Comments suppressed due to low confidence (1)
docs/how-to/configure-and-tune/evaluate-telemetry-volume.md:66
- The code fence closing delimiter here has four backticks instead of three, which will break Markdown rendering for the rest of the page. Make the opening/closing code fence delimiters match.
sum(rate(loki_distributor_bytes_received_total[5m]) / 1e9 * 606024)
sum(rate(loki_distributor_lines_received_total[5m]) * 60)
```
</details>
---
💡 <a href="/canonical/observability-stack/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
|
|
||
| ### COS flavor | ||
|
|
||
| The [flavor of COS](/explanation/overview/what-is-cos) to install depends on your use-case. |
Comment on lines
+75
to
+79
| ## Create Terraform plan | ||
|
|
||
| ```hcl | ||
| module ... { ... } | ||
| ``` |
|
|
||
| ## Deploy COS Alerter | ||
|
|
||
| COS Alerter is a watchdog service for COS you should deploy on a physically different cloud. No newline at end of file |
| curl -sf localhost:8080/metrics | grep -v "^# " | wc -l | ||
| ``` | ||
|
|
||
| This will give you the number of timeseries that will be created for the workload, per unit. |
Comment on lines
29
to
31
| Have your deployment sending all metrics to Prometheus (or Mimir) and inspect the 48hr plot for `count({__name__=~".+"})`. | ||
| The raw data can also be obtained by querying the Prometheus `query` endpoint directly: | ||
|
|
| --- | ||
|
|
||
| # How to install COS | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds an install guide.